home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d27 / ddsgen.arc / DDSGEN.DOC < prev    next >
Encoding:
Text File  |  1991-12-04  |  15.3 KB  |  193 lines
  1.                                                                                 
  2.                     Documentation for DDSGEN command                            
  3.                                                                                 
  4. Purpose:  Generate DDS source specifications for S/38 physical files.           
  5.                                                                                 
  6. Environment:  Interactive or Batch.                                             
  7.                                                                                 
  8.                                                                                 
  9. Program Overview:                                                               
  10.                                                                                 
  11. The DDS generator programs (hereafter called DDSGEN) will create DDS            
  12. specifications for any PHYSICAL FILE on your system.  (Logical and              
  13. Device files are not supported).                                                
  14.                                                                                 
  15. Uses for DDSGEN:                                                                
  16. 1) Replace specifications which have been accidentally erased.                  
  17. 2) Create specifications without referencing keywords (for files                
  18.    created using Field Referencing).  Although the generator supports           
  19.    field referencing, it is often desirable to be able to look up the           
  20.    length and data type attributes of fields in the file source
  21.    specifications.                                                              
  22. 3) Generate source for files created without source (AME).                      
  23.                                                                                 
  24. THE OBJECTS:                                                                    
  25.                                                                                 
  26.    OBJECT     TYPE     ATTR                                                     
  27.                                                                                 
  28.    DDS01C     *PGM     CL     CPP for DDSGEN command.                           
  29.    DDS01CPF   *PGM     CL     Mainline CLP for Physical File DDSGEN.            
  30.    DDS01CSRC  *PGM     CL     Source file parameter validation CLP.             
  31.    DDS01RPF01 *PGM     RPG    RPG to generate file level DDS.                   
  32.    DDS01RPF02 *PGM     RPG    RPG program to generate record level DDS.         
  33.    DDS01RPF03 *PGM     RPG    RPG program to generate field level DDS.          
  34.    DDS01RPF04 *PGM     RPG    RPG program to generate key field DDS.            
  35.    DDSGEN     *CMD            DDS generator command source.                     
  36.                                                                                 
  37.                                                                                 
  38.    PC FILE NAME        S/38 SOURCE MEMBER NAME     SOURCE FILE                  
  39.                                                                                 
  40.    DDSC.CLP            DDS01C                      QCLSRC
  41.    DDSCPF.CLP          DDS01CPF                    QCLSRC              .        
  42.    DDSCSRC.CLP         DDS01CSRC                   QCLSRC                       
  43.    DDSRPF01.RPG        DDS01RPF01                  QRPGSRC                      
  44.    DDSRPF02.RPG        DDS01RPF02                  QRPGSRC             DDS.     
  45.    DDSRPF03.RPG        DDS01RPF03                  QRPGSRC             DS.      
  46.    DDSRPF04.RPG        DDS01RPF04                  QRPGSRC             .        
  47.    DDSGEN.CMD          DDSGEN                      QCMDSRC                      
  48.    DDSGEN.DOC          (ANY NAME)                  QTXTSRC                      
  49.                                                                                 
  50. .pa                                                                             
  51.                                                                                 
  52. DDSGEN COMMAND AND PARAMETERS:                                                  
  53.                                                                                 
  54.                                                                                 
  55.                   Generate File DDS (DDSGEN) Prompt                             
  56. Enter the following:                                                            
  57.   File name:                       FILE       R                                 
  58.     File library:                                   *LIBL                       
  59.   Source file to receive DDS:      SRCFILE    P   QDDSSRC                       
  60.     Source file library:                            *FILELIBR
  61.   Source member Name:              MBR        P   *FILE                         
  62.   REFFLD or ordinary DDS           REF        P   NOREF                         
  63.   TEXT or no text                  TEXT       P   NOTEXT                        
  64.                                                                                 
  65.                                                                                 
  66. 1) File Name:           The name of the physical file.                          
  67. 2) File Library:        The library for the physical file, or *LIBL.            
  68. 3) Source File:         The name of the source file which will                  
  69.                           receive the generated specifications.                 
  70.                                                                                 
  71. 4) Source File Library: The library where the source file is found.             
  72.                                                                                 
  73.                         NOTE WELL!!! The default library for the                
  74.                         source file, is the library where the physical          
  75.                         file is found.  OFTENTIMES THIS FILE ALREADY            
  76.                         CONTAINS SOURCE FOR THE PHYSICAL FILE. DDSGEN           
  77.                         will replace existing source with generated             
  78.                         source.  Be sure to specify a different source          
  79.                         file and library name combination if you                
  80.                         already have source for a physical file stored
  81.                         in QDDSSRC in the same library as the physical          
  82.                         file. Or, use the MBR parameter to specify a            
  83.                         different name for the source that is                   
  84.                         generated.                                              
  85.                                                                                 
  86. 5) Source Member Name:  The name of the generated source member.                
  87.                         The default name is the name of the physical            
  88.                         file.                                                   
  89.                                                                                 
  90. 6) REFFLD or ordinary DDS:                                                      
  91.                         Default is NOREF.                                       
  92.                                                                                 
  93.                         Enter NOREF or N to eliminate the field                 
  94.                         referencing function.                                   
  95.                                                                                 
  96.                         Enter REF or R to use field referencing.                
  97.                                                                                 
  98. 7) TEXT or no text      Default is NOTEXT.                                      
  99.                                                                                 
  100.                         Enter NOTEXT or N to eliminate TEXT keyword
  101.                         generation.  COLHDGs are generated for every            
  102.                         field and the TEXT keyword is unnecessary for           
  103.                         documenting the field.                                  
  104.                                                                                 
  105.                         Enter TEXT or T to generate the TEXT keyword.           
  106. .pa                                                                             
  107.                                                                                 
  108. DDSGEN EXAMPLES:                                                                
  109.                                                                                 
  110.                                                                                 
  111. 1) Sample: Partial listing of P.O. header file, with referencing.               
  112.            Note the specification of a different source file name.              
  113.                                                                                 
  114. DDSGEN     FILE(OPOMST) SRCFILE(QDDSWRK.TERRY) REF(REF)                         
  115.                                                                                 
  116.      A**************************************************************************
  117.      A*                          *  DDSGEN  V 1.4  *                           *
  118.      A*                                                                        *
  119.      A*  FILE NAME:          OPOMST                                            *
  120.      A*                                                                        *
  121.      A*  FILE LIBRARY:       COMLIB                                            *
  122.      A*                                                                        *
  123.      A*  FILE TYPE:          PHYSICAL                                          *
  124.      A*                                                                        *
  125.      A*  FILE CREATION DATE: 11/17/83       TIME:  17.50.27                    *
  126.      A*                                                                        *
  127.      A*  DDS  CREATION DATE: 09/01/87       TIME:  10.56.53                    *
  128.      A*                                                                        *
  129.      A*  FILE TEXT:    OPEN P.O. FILE - CAP, CPO                               *
  130.      A*                                                                        *
  131.      A**************************************************************************
  132.      A*                                                                        *
  133.      A          R OPOFM1                                                        
  134.      A            OPO       R               REFFLD(OPO.DATAFMT CANDTD.COMLIB)   
  135.      A                                      COLHDG('P/O NUMBER')                
  136.      A            OREL      R               REFFLD(OREL.DATAFMT CANDTD.COMLIB)  
  137.      A                                      COLHDG('ORDER RELEASE')             
  138.      A            OVEN#     R               REFFLD(OVEN#.DATAFMT CANDTD.COMLIB) 
  139.      A                                      COLHDG('VENDOR NUMBER')             
  140.      A            OCD1      R               REFFLD(OCD1.DATAFMT CANDTD.COMLIB)
  141.      A                                      COLHDG('BLANKET CODE')              
  142.      A            OCD2      R               REFFLD(OCD2.DATAFMT CANDTD.COMLIB)  
  143.      A                                      COLHDG('STATUS' 'CODE')             
  144.      A            OCD3      R               REFFLD(OCD3.DATAFMT CANDTD.COMLIB)  
  145.      A                                      COLHDG('RECEIVING REQUIRED' 'CODE') 
  146.      A            OCD4      R               REFFLD(OCD4.DATAFMT CANDTD.COMLIB)  
  147.      A                                      COLHDG('PRINT' 'OPTION')            
  148.      A            OCD5      R               REFFLD(OCD5.DATAFMT CANDTD.COMLIB)  
  149.      A                                      COLHDG('CLOSED' 'CODE')             
  150.      A            OCD6      R               REFFLD(OCD6.DATAFMT CANDTD.COMLIB)  
  151.      A                                      COLHDG('FUTURE' 'CODE')             
  152.      A          K OPO                       UNSIGNED                            
  153.      A          K OREL                      UNSIGNED                            
  154. .pa                                                                             
  155.                                                                                 
  156. DDSGEN EXAMPLES:                                                                
  157.                                                                                 
  158.                                                                                 
  159. 2) Sample: Partial listing of P.O. header file, WITHOUT referencing.            
  160.            Note the specification of a different source MEMBER name.
  161.                                                                                 
  162. DDSGEN     FILE(OPOMST) MBR(OPOWRK)                                             
  163.                                                                                 
  164.      A**************************************************************************
  165.      A*                          *  DDSGEN  V 1.4  *                           *
  166.      A*                                                                        *
  167.      A*  FILE NAME:          OPOMST                                            *
  168.      A*                                                                        *
  169.      A*  FILE LIBRARY:       COMLIB                                            *
  170.      A*                                                                        *
  171.      A*  FILE TYPE:          PHYSICAL                                          *
  172.      A*                                                                        *
  173.      A*  FILE CREATION DATE: 11/17/83       TIME:  17.50.27                    *
  174.      A*                                                                        *
  175.      A*  DDS  CREATION DATE: 09/01/87       TIME:  11.09.06                    *
  176.      A*                                                                        *
  177.      A*  FILE TEXT:    OPEN P.O. FILE - CAP, CPO                               *
  178.      A*                                                                        *
  179.      A**************************************************************************
  180.      A*                                                                        *
  181.      A          R OPOFM1                                                        
  182.      A            OPO            6P 0       COLHDG('P/O NUMBER')                
  183.      A            OREL           3P 0       COLHDG('ORDER RELEASE')             
  184.      A            OCD1           1A         COLHDG('BLANKET CODE')              
  185.      A            OCD2           1A         COLHDG('STATUS' 'CODE')             
  186.      A            OCD3           1A         COLHDG('RECEIVING REQUIRED' 'CODE') 
  187.      A            OCD4           1A         COLHDG('PRINT' 'OPTION')            
  188.      A            OCD5           1A         COLHDG('CLOSED' 'CODE')             
  189.      A            OCD6           1A         COLHDG('FUTURE' 'CODE')             
  190.      A          K OPO                       UNSIGNED                            
  191.      A          K OREL                      UNSIGNED
  192. 
  193.